Skip to content

Conversation

@Wauplin
Copy link
Contributor

@Wauplin Wauplin commented Sep 19, 2024

This PR adds a template with a checklist to follow when adding a new library.

Based on https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.

Once merged, we should be able to generate a link to create such a PR (the template will not be used by default for all PRs 😄). This link would be added to https://huggingface.co/docs/hub/models-download-stats#can-i-add-my-query-files-for-my-library.

Hopefully, this should reduce the back-and-fourth when someone adds a new library. I suggest we start with that as an experiment and if it doesn't work, we can move it somewhere else as documentation.

Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for opening this! Indeed is needed.

I just wonder if we need the snippets bit as not a lot of libraries have it and seeing a wall of text as the first thing might deter them from making a contribution WDYT?

Copy link
Member

@julien-c julien-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks nice!

@Wauplin
Copy link
Contributor Author

Wauplin commented Sep 20, 2024

I've addressed feedback in b54ffcc. I have added "(optional)" in the snippets title to make it clear it's optional. Let's merge it as it is and reassess after if needed.

@Wauplin Wauplin merged commit c488b19 into main Sep 20, 2024
5 checks passed
@Wauplin Wauplin deleted the add-pr-template-to-add-library branch September 20, 2024 10:52
@Wauplin
Copy link
Contributor Author

Wauplin commented Sep 20, 2024

Well, I've been enthusiastic a bit too quickly... This feature requires the user to manually edit their URL to make it work >< . I'll try to hack something based on https://stackoverflow.com/questions/73771068/multiple-templates-for-pull-requests-on-github

Wauplin added a commit that referenced this pull request Oct 9, 2024
Reverting #913 now
that huggingface/hub-docs#1442 has been merged.
The PR template was not discoverable at all. Now users should be
redirected to https://huggingface.co/docs/hub/models-adding-libraries
which contains the same information.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants